SDF 문서 구조 정리 기획안
개요
본 문서는 SDF 제품 문서를 중앙화 및 체계화하기 위한 기획안입니다.
현재 산출물들이 개인 PC, 부서별 폴더, 프로젝트 단위 저장소 등으로 분산되어 관리되고 있으며, 이로 인해 다음과 같은 문제가 발생하고 있습니다.
- 문서의 위치 파악이 어렵고 검색성이 떨어짐
- 담당자 변경 시 인수인계 지연 및 누락 발생
- 동일/유사 문서의 중복 작성으로 인한 비효율
이에 따라, 본 기획안은 외부 제공용 문서(영업–준비–구축–검수) 와 내부 관리용 문서(기획–개발–QA–운영) 를 모두 포함하는 이중 구조 문서 체계를 수립하여, 전사적으로 일관성 있고 재사용 가능한 문서 관리 체계를 마련하는 것을 목표로 합니다.
문제 인식
- 분산 관리로 인해 문서 품질, 접근성, 재활용성 저하
개선 필요성
- 중앙화 : 모든 산출물을 단일 저장소에서 관리
- 체계화 : 단계별 산출물 구조를 정의하고 템플릿 기반 관리
- 재사용성 모든 제품 docs 동일한 구조 적용
- 품질 관리 : 버전 관리, 검수 기록, 담당자 메타데이터 포함
제안 구조
1. 외부 제공 문서
- 영업 단계 : 제품 소개자료, 브로슈어, 기능 리스트, FAQ
- 준비 단계 : 환경분석 질의서, 제품 구성도, H/W 스펙
- 구축 단계 : 설치 가이드, API 명세서, 테스트 소스, 트러블슈팅
- 검수 단계 : 설치 확인서
2. 내부 관리 문서
- 기획 (Planning) : 로드맵, 요구사항 정의서, 기능 명세서, 릴리즈 계획
- 개발 (Development) : 아키텍처 설계, DB 스키마, 내부 API 명세, 개발 로그
- 품질 관리 (QA) : 테스트 케이스, 버그 리포트, 회귀 테스트 체크리스트
- 운영 (Ops) : 모니터링 가이드, 장애 보고서, SLA 문서
3. 통합 폴더 트리
docs-sdf/
├─ external/ # 외부 제공 문서 (고객/영업/구축/검수)
│
│ ├─ 01.Sales/ # 메뉴: 영업 단계
│ │ ├─ Product_Intro/ # 메뉴: 제품 소개자료
│ │ ├─ Brochure/ # 메뉴: 브로슈어
│ │ ├─ Feature_List/ # 메뉴: 기능 리스트
│ │ └─ FAQ/ # 메뉴: FAQ (영업용)
│
│ ├─ 02.Preparation/ # 메뉴: 준비 단계
│ │ ├─ Pre_Survey_QA/ # 메뉴: 사전 환경분석 질의서
│ │ ├─ System_Architecture/ # 메뉴: 제품 구성도
│ │ └─ HW_Spec/ # 메뉴: 하드웨어 스펙
│
│ ├─ 03.Deployment/ # 메뉴: 구축 단계
│ │
│ │ ├─ SDF_App/ # 메뉴: SDF APP 구축
│ │ │ ├─ Install_Guide/ # 메뉴: 설치 가이드 (App)
│ │ │ ├─ API_Spec/ # 메뉴: API 명세서 (App)
│ │ │ ├─ Architecture_Diagram/ # 메뉴: 구성도 (App)
│ │ │ └─ Troubleshooting/ # 메뉴: 트러블슈팅 (App) / JAR 실행 문제, API 호출 실패
│ │
│ │ ├─ SDF_Container/ # 메뉴: SDF Container 구축
│ │ │ ├─ Install_Guide/ # 메뉴: 설치 가이드 (Container)
│ │ │ ├─ API_Spec/ # 메뉴: API 명세서 (Container)
│ │ │ ├─ Architecture_Diagram/ # 메뉴: 구성도 (Container)
│ │ │ └─ Troubleshooting/ # 메뉴: 트러블슈팅 (Container) / Pod CrashLoopBackOff,이미지 Pull 오류
│ │
│ │ └─ SDF_Windows/ (예정) # 메뉴: SDF Windows 구축 (예정)
│ │ ├─ Install_Guide/ # 메뉴: 설치 가이드 (Windows)
│ │ ├─ API_Spec/ # 메뉴: API 명세서 (Windows)
│ │ ├─ Architecture_Diagram/ # 메뉴: 구성도 (Windows)
│ │ └─ Troubleshooting/ # 메뉴: 트러블슈팅 (Windows) / 에이전트 충돌, OS 서비스 비정상 종료
│ │
│ └─ 04.Validation/ # 메뉴: 검수 단계
│ └─ Installation_Checklist/ # 메뉴: 설치 확인서 / 체크리스트
│
├─ internal/ # 내부 관리 문서 (기획/개발/QA/운영)
│ ├─ 10.Planning/ # 기획/계획 관련
│ │ ├─ Iteration/ # 이터레이션
│ │ ├─ Roadmap/ # 로드맵
│ │ └─ Function_Spec/ # 기능 명세서(내부용)
│ │
│ ├─ 20.Development/ # 개발 관련
│ │ ├─ Dev_Docs/ # 개발자 문서
│ │ ├─ UseCase/ # 유스케이스
│ │ ├─ Process/ # 프로세스
│ │ ├─ Sample/ # 샘 플
│ │ ├─ Study/ # 스터디/기술 연구
│ │ ├─ Backup/ (deprecated) # 백업 (삭제 예정)
│ │ └─ Wiki_Links/ # Wiki 링크 모음
│ │
│ ├─ 30.Log/ # 로그 관리
│ │
│ ├─ 40.Ops/ # 운영/구축 이력/설정
│ │ ├─ Deployment_History/ # 구축 시 장애 이력
│ │ ├─ Architecture_Model/ # 모델 유형 (Cloud, On-Premise 등)
│ │ ├─ Settings/ # 설정 문서
│ │ └─ Incident_Report/ # 장애 보고서
│ │
│ └─ 50.Internal_FAQ/ # 내부 FAQ
│
├─ _assets/ # 이미지, 다이어그램, 스크린샷
├─ _templates/ # 공통 문서 템플릿
└─ README.md # 개요/버전 규칙/담당자 정보
추진 계획
- 1단계 (초안 설계) : 폴더 트리 생성 및 템플릿 제작
- 2단계 (문서 이관) : 기존 문서를 신규 구조에 맞춰 이동 및 정리
- 3단계 (부서 검토) : 기획/개발/영업/운영 각 부서별 검토
- 4단계 (적용/확산) : SDF 우선 적용 후 타제품(DRM, Mail) 동일 체계로 확산
기대 효과
- 문서 중앙화 : 흩어진 산출물을 단일 저장소로 집약 → 접근성·검색성 개선
- 체계화 : 외부·내부 이중 구조를 반영하여 산출물 누락 방지
- 재사용성 강화 : DRM, Mail 등 타 제품에도 동일 구조 적용 가능
- 품질 관리 강화 : 버전 관리·검수 기록 기반으로 문서 품질 일관성 유지
- 조직 신뢰 향상 : 고객사·내부 협업 모두에서 문서 제공 품질 향상